Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add swagger plugin #120

Merged
merged 1 commit into from
Aug 1, 2024
Merged

Add swagger plugin #120

merged 1 commit into from
Aug 1, 2024

Conversation

khkim6040
Copy link
Member

@khkim6040 khkim6040 commented Jul 24, 2024

swagger 플러그인을 적용했습니다. 모든 dto, entity 파일에 간단한 swagger 기능이 자동으로 적용되어 따로 데코레이터를 붙이지 않아도 swagger 문서 상에서 DTO 형식 및 request, response의 json 형식 예시를 확인할 수 있습니다.
@IsInt 같은 class-validator는 직접 추가해줘야 합니다.
아래는 해당 브랜치가 반영된 dev서버의 swagger 문서
image
image

It automatically put ApiProperty decorators and an example response
@BlueHorn07
Copy link
Member

looks good! ApiProperty 넣어줬던 다른 것도 체크해보면 좋겠네요

@khkim6040
Copy link
Member Author

looks good! ApiProperty 넣어줬던 다른 것도 체크해보면 좋겠네요

reserve.place.dto.ts 제외하고 ApiProperty 있는 파일은 없었는데 혹시 수정하면 좋을 게 있을까요?

@khkim6040 khkim6040 added the documentation Improvements or additions to documentation label Jul 24, 2024
@khkim6040 khkim6040 self-assigned this Jul 24, 2024
@BlueHorn07 BlueHorn07 merged commit 1e42f9b into main Aug 1, 2024
5 checks passed
@BlueHorn07 BlueHorn07 deleted the feature/swagger-readability branch August 1, 2024 11:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants